<!-- HTML header for doxygen 1.8.13-->
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
<meta http-equiv="X-UA-Compatible" content="IE=9"/>
<meta name="generator" content="Doxygen 1.9.2"/>
<meta name="viewport" content="width=device-width, initial-scale=1"/>
<title>Wi-Fi Connection Manager Library: Functions</title>
<link href="tabs.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="jquery.js"></script>
<script type="text/javascript" src="dynsections.js"></script>
<link href="navtree.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="resize.js"></script>
<script type="text/javascript" src="navtreedata.js"></script>
<script type="text/javascript" src="navtree.js"></script>
<link href="search/search.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="search/searchdata.js"></script>
<script type="text/javascript" src="search/search.js"></script>
<link href="doxygen_style.css" rel="stylesheet" type="text/css" />
</head>
<body>
<div id="top"><!-- do not remove this div, it is closed by doxygen! -->
<div id="titlearea">
<table cellspacing="0" cellpadding="0">
 <tbody>
 <tr style="height: 56px;">
  <td id="projectlogo"><a href="http://www.cypress.com/"><img alt="Logo" src="cypress_logo.png"/></a></td>
  <td id="projectalign" style="padding-left: 0.5em;">
   <div id="projectname">Wi-Fi Connection Manager Library</div>
  </td>
 </tr>
 </tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.9.2 -->
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&amp;dn=expat.txt MIT */
var searchBox = new SearchBox("searchBox", "search",'Search','.html');
/* @license-end */
</script>
<script type="text/javascript" src="menudata.js"></script>
<script type="text/javascript" src="menu.js"></script>
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&amp;dn=expat.txt MIT */
$(function() {
  initMenu('',true,false,'search.php','Search');
  $(document).ready(function() { init_search(); });
});
/* @license-end */
</script>
<div id="main-nav"></div>
</div><!-- top -->
<div id="side-nav" class="ui-resizable side-nav-resizable">
  <div id="nav-tree">
    <div id="nav-tree-contents">
      <div id="nav-sync" class="sync"></div>
    </div>
  </div>
  <div id="splitbar" style="-moz-user-select:none;" 
       class="ui-resizable-handle">
  </div>
</div>
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&amp;dn=expat.txt MIT */
$(document).ready(function(){initNavTree('group__group__wcm__functions.html',''); initResizable(); });
/* @license-end */
</script>
<div id="doc-content">
<!-- window showing the filter options -->
<div id="MSearchSelectWindow"
     onmouseover="return searchBox.OnSearchSelectShow()"
     onmouseout="return searchBox.OnSearchSelectHide()"
     onkeydown="return searchBox.OnSearchSelectKey(event)">
</div>

<!-- iframe showing the search results (closed by default) -->
<div id="MSearchResultsWindow">
<iframe src="javascript:void(0)" frameborder="0" 
        name="MSearchResults" id="MSearchResults">
</iframe>
</div>

<div class="header">
  <div class="summary">
<a href="#func-members">Functions</a>  </div>
  <div class="headertitle"><div class="title">Functions</div></div>
</div><!--header-->
<div class="contents">
<a name="details" id="details"></a><h2 class="groupheader">General Description</h2>
<ul>
<li>The WCM library internally creates a thread; the created threads are executed with the "CY_RTOS_PRIORITY_ABOVENORMAL" priority. The definition of the CY_RTOS_PRIORITY_ABOVENORMAL macro is located at "libs/abstraction-rtos/include/COMPONENT_FREERTOS/cyabs_rtos_impl.h".</li>
<li>The WCM APIs are thread-safe.</li>
<li>All the WCM APIs except <a class="el" href="group__group__wcm__functions.html#gae0f0b5f3e6138bfdae943e9f7b16aa07">cy_wcm_start_scan</a> are blocking APIs.</li>
<li><a class="el" href="group__group__wcm__functions.html#gae0f0b5f3e6138bfdae943e9f7b16aa07">cy_wcm_start_scan</a> is a non-blocking API; scan results are delivered via <a class="el" href="group__group__wcm__typedefs.html#ga58bd6c567dc6b0b111fb5852227c0c88">cy_wcm_scan_result_callback_t</a>.</li>
<li>All application callbacks invoked by the WCM will be running in the context of the WCM; the pointers passed as argument in the callback function will be freed once the function returns.</li>
<li>For the APIs that expect <a class="el" href="group__group__wcm__enums.html#gac4c4ca6db8db6efdc3013b789a4c9cf8">cy_wcm_interface_t</a> as an argument, unless a specific interface type has been called out in the description of the API, any valid WCM interface type can be passed as an argument to the API. </li>
</ul>
<table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a id="func-members" name="func-members"></a>
Functions</h2></td></tr>
<tr class="memitem:ga888428a2325f131528f7447e894002eb"><td class="memItemLeft" align="right" valign="top">cy_rslt_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__group__wcm__functions.html#ga888428a2325f131528f7447e894002eb">cy_wcm_init</a> (<a class="el" href="structcy__wcm__config__t.html">cy_wcm_config_t</a> *config)</td></tr>
<tr class="memdesc:ga888428a2325f131528f7447e894002eb"><td class="mdescLeft">&#160;</td><td class="mdescRight">Initializes the WCM.  <a href="group__group__wcm__functions.html#ga888428a2325f131528f7447e894002eb">More...</a><br /></td></tr>
<tr class="separator:ga888428a2325f131528f7447e894002eb"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ga5699a6a4d8f914d86022f3f973916316"><td class="memItemLeft" align="right" valign="top">cy_rslt_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__group__wcm__functions.html#ga5699a6a4d8f914d86022f3f973916316">cy_wcm_deinit</a> (void)</td></tr>
<tr class="memdesc:ga5699a6a4d8f914d86022f3f973916316"><td class="mdescLeft">&#160;</td><td class="mdescRight">Shuts down the WCM.  <a href="group__group__wcm__functions.html#ga5699a6a4d8f914d86022f3f973916316">More...</a><br /></td></tr>
<tr class="separator:ga5699a6a4d8f914d86022f3f973916316"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:gae0f0b5f3e6138bfdae943e9f7b16aa07"><td class="memItemLeft" align="right" valign="top">cy_rslt_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__group__wcm__functions.html#gae0f0b5f3e6138bfdae943e9f7b16aa07">cy_wcm_start_scan</a> (<a class="el" href="group__group__wcm__typedefs.html#ga58bd6c567dc6b0b111fb5852227c0c88">cy_wcm_scan_result_callback_t</a> scan_callback, void *user_data, <a class="el" href="structcy__wcm__scan__filter__t.html">cy_wcm_scan_filter_t</a> *scan_filter)</td></tr>
<tr class="memdesc:gae0f0b5f3e6138bfdae943e9f7b16aa07"><td class="mdescLeft">&#160;</td><td class="mdescRight">Performs a Wi-Fi network scan.  <a href="group__group__wcm__functions.html#gae0f0b5f3e6138bfdae943e9f7b16aa07">More...</a><br /></td></tr>
<tr class="separator:gae0f0b5f3e6138bfdae943e9f7b16aa07"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ga6c18f6560c581912393e297b1560d3c7"><td class="memItemLeft" align="right" valign="top">cy_rslt_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__group__wcm__functions.html#ga6c18f6560c581912393e297b1560d3c7">cy_wcm_stop_scan</a> (void)</td></tr>
<tr class="memdesc:ga6c18f6560c581912393e297b1560d3c7"><td class="mdescLeft">&#160;</td><td class="mdescRight">Stops an ongoing Wi-Fi network scan.  <a href="group__group__wcm__functions.html#ga6c18f6560c581912393e297b1560d3c7">More...</a><br /></td></tr>
<tr class="separator:ga6c18f6560c581912393e297b1560d3c7"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ga0aae35b5ae477a1a10caccf937beff0d"><td class="memItemLeft" align="right" valign="top">cy_rslt_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__group__wcm__functions.html#ga0aae35b5ae477a1a10caccf937beff0d">cy_wcm_connect_ap</a> (<a class="el" href="structcy__wcm__connect__params__t.html">cy_wcm_connect_params_t</a> *connect_params, <a class="el" href="structcy__wcm__ip__address__t.html">cy_wcm_ip_address_t</a> *ip_addr)</td></tr>
<tr class="memdesc:ga0aae35b5ae477a1a10caccf937beff0d"><td class="mdescLeft">&#160;</td><td class="mdescRight">Connects the STA interface to a AP using the Wi-Fi credentials and configuration parameters provided.  <a href="group__group__wcm__functions.html#ga0aae35b5ae477a1a10caccf937beff0d">More...</a><br /></td></tr>
<tr class="separator:ga0aae35b5ae477a1a10caccf937beff0d"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:gaabda4c932e13e0c8f29486d393a18c5b"><td class="memItemLeft" align="right" valign="top">cy_rslt_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__group__wcm__functions.html#gaabda4c932e13e0c8f29486d393a18c5b">cy_wcm_disconnect_ap</a> (void)</td></tr>
<tr class="memdesc:gaabda4c932e13e0c8f29486d393a18c5b"><td class="mdescLeft">&#160;</td><td class="mdescRight">Disconnects the STA interface from the currently connected AP.  <a href="group__group__wcm__functions.html#gaabda4c932e13e0c8f29486d393a18c5b">More...</a><br /></td></tr>
<tr class="separator:gaabda4c932e13e0c8f29486d393a18c5b"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:gad15fb09ca84b85997b967c3a22f9676c"><td class="memItemLeft" align="right" valign="top">cy_rslt_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__group__wcm__functions.html#gad15fb09ca84b85997b967c3a22f9676c">cy_wcm_get_ip_addr</a> (<a class="el" href="group__group__wcm__enums.html#gac4c4ca6db8db6efdc3013b789a4c9cf8">cy_wcm_interface_t</a> interface_type, <a class="el" href="structcy__wcm__ip__address__t.html">cy_wcm_ip_address_t</a> *ip_addr)</td></tr>
<tr class="memdesc:gad15fb09ca84b85997b967c3a22f9676c"><td class="mdescLeft">&#160;</td><td class="mdescRight">Retrieves the IPv4 address of the given interface.  <a href="group__group__wcm__functions.html#gad15fb09ca84b85997b967c3a22f9676c">More...</a><br /></td></tr>
<tr class="separator:gad15fb09ca84b85997b967c3a22f9676c"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ga88dbfc2742725a2c54223740cb27b518"><td class="memItemLeft" align="right" valign="top">cy_rslt_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__group__wcm__functions.html#ga88dbfc2742725a2c54223740cb27b518">cy_wcm_get_ipv6_addr</a> (<a class="el" href="group__group__wcm__enums.html#gac4c4ca6db8db6efdc3013b789a4c9cf8">cy_wcm_interface_t</a> interface_type, <a class="el" href="group__group__wcm__enums.html#ga04051d082e24439e436a17db75fadfef">cy_wcm_ipv6_type_t</a> ipv6_addr_type, <a class="el" href="structcy__wcm__ip__address__t.html">cy_wcm_ip_address_t</a> *ip_addr)</td></tr>
<tr class="memdesc:ga88dbfc2742725a2c54223740cb27b518"><td class="mdescLeft">&#160;</td><td class="mdescRight">Retrieves the IPv6 address of the given interface.  <a href="group__group__wcm__functions.html#ga88dbfc2742725a2c54223740cb27b518">More...</a><br /></td></tr>
<tr class="separator:ga88dbfc2742725a2c54223740cb27b518"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ga4cb1814cad97c2462b27aec17294acfb"><td class="memItemLeft" align="right" valign="top">cy_rslt_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__group__wcm__functions.html#ga4cb1814cad97c2462b27aec17294acfb">cy_wcm_get_gateway_ip_address</a> (<a class="el" href="group__group__wcm__enums.html#gac4c4ca6db8db6efdc3013b789a4c9cf8">cy_wcm_interface_t</a> interface_type, <a class="el" href="structcy__wcm__ip__address__t.html">cy_wcm_ip_address_t</a> *gateway_addr)</td></tr>
<tr class="memdesc:ga4cb1814cad97c2462b27aec17294acfb"><td class="mdescLeft">&#160;</td><td class="mdescRight">Retrieves the gateway IP address of the given interface.  <a href="group__group__wcm__functions.html#ga4cb1814cad97c2462b27aec17294acfb">More...</a><br /></td></tr>
<tr class="separator:ga4cb1814cad97c2462b27aec17294acfb"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ga0646e1f8eba6cda184c0251f504d6b69"><td class="memItemLeft" align="right" valign="top">cy_rslt_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__group__wcm__functions.html#ga0646e1f8eba6cda184c0251f504d6b69">cy_wcm_get_ip_netmask</a> (<a class="el" href="group__group__wcm__enums.html#gac4c4ca6db8db6efdc3013b789a4c9cf8">cy_wcm_interface_t</a> interface_type, <a class="el" href="structcy__wcm__ip__address__t.html">cy_wcm_ip_address_t</a> *net_mask_addr)</td></tr>
<tr class="memdesc:ga0646e1f8eba6cda184c0251f504d6b69"><td class="mdescLeft">&#160;</td><td class="mdescRight">Retrieves the subnet mask address of the given interface.  <a href="group__group__wcm__functions.html#ga0646e1f8eba6cda184c0251f504d6b69">More...</a><br /></td></tr>
<tr class="separator:ga0646e1f8eba6cda184c0251f504d6b69"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ga0f9d3431e34472921e6b89d0a51d1538"><td class="memItemLeft" align="right" valign="top">cy_rslt_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__group__wcm__functions.html#ga0f9d3431e34472921e6b89d0a51d1538">cy_wcm_get_mac_addr</a> (<a class="el" href="group__group__wcm__enums.html#gac4c4ca6db8db6efdc3013b789a4c9cf8">cy_wcm_interface_t</a> interface_type, <a class="el" href="group__group__wcm__typedefs.html#ga510db2323122294f3956024396ba2ff5">cy_wcm_mac_t</a> *mac_addr)</td></tr>
<tr class="memdesc:ga0f9d3431e34472921e6b89d0a51d1538"><td class="mdescLeft">&#160;</td><td class="mdescRight">Retrieves the MAC address of the given interface.  <a href="group__group__wcm__functions.html#ga0f9d3431e34472921e6b89d0a51d1538">More...</a><br /></td></tr>
<tr class="separator:ga0f9d3431e34472921e6b89d0a51d1538"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ga97e7212b4d3392a310682ff02f0d8d51"><td class="memItemLeft" align="right" valign="top">cy_rslt_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__group__wcm__functions.html#ga97e7212b4d3392a310682ff02f0d8d51">cy_wcm_wps_enrollee</a> (<a class="el" href="structcy__wcm__wps__config__t.html">cy_wcm_wps_config_t</a> *config, const <a class="el" href="structcy__wcm__wps__device__detail__t.html">cy_wcm_wps_device_detail_t</a> *details, <a class="el" href="structcy__wcm__wps__credential__t.html">cy_wcm_wps_credential_t</a> *credentials, uint16_t *credential_count)</td></tr>
<tr class="memdesc:ga97e7212b4d3392a310682ff02f0d8d51"><td class="mdescLeft">&#160;</td><td class="mdescRight">Negotiates securely with a Wi-Fi Protected Setup (WPS) Registrar (usually an AP) and obtains the Wi-Fi network credentials.  <a href="group__group__wcm__functions.html#ga97e7212b4d3392a310682ff02f0d8d51">More...</a><br /></td></tr>
<tr class="separator:ga97e7212b4d3392a310682ff02f0d8d51"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ga0369189fc2845efdf57cd3ce9b0d188e"><td class="memItemLeft" align="right" valign="top">cy_rslt_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__group__wcm__functions.html#ga0369189fc2845efdf57cd3ce9b0d188e">cy_wcm_wps_generate_pin</a> (char wps_pin_string[<a class="el" href="group__group__wcm__macros.html#ga2fd33d6cf6472c7452a22e5988e69516">CY_WCM_WPS_PIN_LENGTH</a>])</td></tr>
<tr class="memdesc:ga0369189fc2845efdf57cd3ce9b0d188e"><td class="mdescLeft">&#160;</td><td class="mdescRight">Generates a random WPS PIN for PIN mode connection.  <a href="group__group__wcm__functions.html#ga0369189fc2845efdf57cd3ce9b0d188e">More...</a><br /></td></tr>
<tr class="separator:ga0369189fc2845efdf57cd3ce9b0d188e"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ga02f205b4d522c99d6c0b48f15683b0b6"><td class="memItemLeft" align="right" valign="top">cy_rslt_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__group__wcm__functions.html#ga02f205b4d522c99d6c0b48f15683b0b6">cy_wcm_register_event_callback</a> (<a class="el" href="group__group__wcm__typedefs.html#ga5f028848682f04705e669b6823d290fb">cy_wcm_event_callback_t</a> event_callback)</td></tr>
<tr class="memdesc:ga02f205b4d522c99d6c0b48f15683b0b6"><td class="mdescLeft">&#160;</td><td class="mdescRight">Registers an event callback to monitor the connection and IP address change events.  <a href="group__group__wcm__functions.html#ga02f205b4d522c99d6c0b48f15683b0b6">More...</a><br /></td></tr>
<tr class="separator:ga02f205b4d522c99d6c0b48f15683b0b6"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ga957a1964b1a2bf191266ee3e60549b9e"><td class="memItemLeft" align="right" valign="top">cy_rslt_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__group__wcm__functions.html#ga957a1964b1a2bf191266ee3e60549b9e">cy_wcm_deregister_event_callback</a> (<a class="el" href="group__group__wcm__typedefs.html#ga5f028848682f04705e669b6823d290fb">cy_wcm_event_callback_t</a> event_callback)</td></tr>
<tr class="memdesc:ga957a1964b1a2bf191266ee3e60549b9e"><td class="mdescLeft">&#160;</td><td class="mdescRight">De-registers an event callback.  <a href="group__group__wcm__functions.html#ga957a1964b1a2bf191266ee3e60549b9e">More...</a><br /></td></tr>
<tr class="separator:ga957a1964b1a2bf191266ee3e60549b9e"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ga98c3513c75507fcddb7650b7d20b6f3a"><td class="memItemLeft" align="right" valign="top">uint8_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__group__wcm__functions.html#ga98c3513c75507fcddb7650b7d20b6f3a">cy_wcm_is_connected_to_ap</a> (void)</td></tr>
<tr class="memdesc:ga98c3513c75507fcddb7650b7d20b6f3a"><td class="mdescLeft">&#160;</td><td class="mdescRight">Checks if the STA interface is connected to an AP.  <a href="group__group__wcm__functions.html#ga98c3513c75507fcddb7650b7d20b6f3a">More...</a><br /></td></tr>
<tr class="separator:ga98c3513c75507fcddb7650b7d20b6f3a"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:gad91ebcdcf8452d23b68cf3b225b4ea33"><td class="memItemLeft" align="right" valign="top">cy_rslt_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__group__wcm__functions.html#gad91ebcdcf8452d23b68cf3b225b4ea33">cy_wcm_get_associated_ap_info</a> (<a class="el" href="structcy__wcm__associated__ap__info__t.html">cy_wcm_associated_ap_info_t</a> *ap_info)</td></tr>
<tr class="memdesc:gad91ebcdcf8452d23b68cf3b225b4ea33"><td class="mdescLeft">&#160;</td><td class="mdescRight">Retrieves the information such as SSID, BSSID, and other details of the AP to which the STA interface is connected.  <a href="group__group__wcm__functions.html#gad91ebcdcf8452d23b68cf3b225b4ea33">More...</a><br /></td></tr>
<tr class="separator:gad91ebcdcf8452d23b68cf3b225b4ea33"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ga6bf5f2a11f6b9a91d1be40cf79ab7e8c"><td class="memItemLeft" align="right" valign="top">cy_rslt_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__group__wcm__functions.html#ga6bf5f2a11f6b9a91d1be40cf79ab7e8c">cy_wcm_get_wlan_statistics</a> (<a class="el" href="group__group__wcm__enums.html#gac4c4ca6db8db6efdc3013b789a4c9cf8">cy_wcm_interface_t</a> interface, <a class="el" href="structcy__wcm__wlan__statistics__t.html">cy_wcm_wlan_statistics_t</a> *stat)</td></tr>
<tr class="memdesc:ga6bf5f2a11f6b9a91d1be40cf79ab7e8c"><td class="mdescLeft">&#160;</td><td class="mdescRight">Gets the WLAN statistics of the given interface from the time WLAN driver is up and running.  <a href="group__group__wcm__functions.html#ga6bf5f2a11f6b9a91d1be40cf79ab7e8c">More...</a><br /></td></tr>
<tr class="separator:ga6bf5f2a11f6b9a91d1be40cf79ab7e8c"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ga70f40907d2f1668b8fa356f8095fc172"><td class="memItemLeft" align="right" valign="top">cy_rslt_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__group__wcm__functions.html#ga70f40907d2f1668b8fa356f8095fc172">cy_wcm_get_gateway_mac_address</a> (<a class="el" href="group__group__wcm__typedefs.html#ga510db2323122294f3956024396ba2ff5">cy_wcm_mac_t</a> *mac_addr)</td></tr>
<tr class="memdesc:ga70f40907d2f1668b8fa356f8095fc172"><td class="mdescLeft">&#160;</td><td class="mdescRight">Retrieves the MAC address of the gateway for STA interface.  <a href="group__group__wcm__functions.html#ga70f40907d2f1668b8fa356f8095fc172">More...</a><br /></td></tr>
<tr class="separator:ga70f40907d2f1668b8fa356f8095fc172"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:gaa42251a4b728f775786d1781afbc32a2"><td class="memItemLeft" align="right" valign="top">cy_rslt_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__group__wcm__functions.html#gaa42251a4b728f775786d1781afbc32a2">cy_wcm_ping</a> (<a class="el" href="group__group__wcm__enums.html#gac4c4ca6db8db6efdc3013b789a4c9cf8">cy_wcm_interface_t</a> interface, <a class="el" href="structcy__wcm__ip__address__t.html">cy_wcm_ip_address_t</a> *ip_addr, uint32_t timeout_ms, uint32_t *elapsed_ms)</td></tr>
<tr class="memdesc:gaa42251a4b728f775786d1781afbc32a2"><td class="mdescLeft">&#160;</td><td class="mdescRight">Sends a ping request to the given IP address.  <a href="group__group__wcm__functions.html#gaa42251a4b728f775786d1781afbc32a2">More...</a><br /></td></tr>
<tr class="separator:gaa42251a4b728f775786d1781afbc32a2"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ga4b6c66ca0e28ef817bdab02c56d180e6"><td class="memItemLeft" align="right" valign="top">cy_rslt_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__group__wcm__functions.html#ga4b6c66ca0e28ef817bdab02c56d180e6">cy_wcm_start_ap</a> (const <a class="el" href="structcy__wcm__ap__config__t.html">cy_wcm_ap_config_t</a> *ap_config)</td></tr>
<tr class="memdesc:ga4b6c66ca0e28ef817bdab02c56d180e6"><td class="mdescLeft">&#160;</td><td class="mdescRight">Starts an infrastructure Wi-Fi network (SoftAP).  <a href="group__group__wcm__functions.html#ga4b6c66ca0e28ef817bdab02c56d180e6">More...</a><br /></td></tr>
<tr class="separator:ga4b6c66ca0e28ef817bdab02c56d180e6"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:gaaf300adeaed2e9251dc85d6c85be9d72"><td class="memItemLeft" align="right" valign="top">cy_rslt_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__group__wcm__functions.html#gaaf300adeaed2e9251dc85d6c85be9d72">cy_wcm_stop_ap</a> (void)</td></tr>
<tr class="memdesc:gaaf300adeaed2e9251dc85d6c85be9d72"><td class="mdescLeft">&#160;</td><td class="mdescRight">Stops the infrastructure Wi-Fi network (SoftAP), removes the information element and stops the internal DHCP server.  <a href="group__group__wcm__functions.html#gaaf300adeaed2e9251dc85d6c85be9d72">More...</a><br /></td></tr>
<tr class="separator:gaaf300adeaed2e9251dc85d6c85be9d72"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:gac2570e24e41dc550252205489f56cc0f"><td class="memItemLeft" align="right" valign="top">cy_rslt_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__group__wcm__functions.html#gac2570e24e41dc550252205489f56cc0f">cy_wcm_get_associated_client_list</a> (<a class="el" href="group__group__wcm__typedefs.html#ga510db2323122294f3956024396ba2ff5">cy_wcm_mac_t</a> *sta_list, uint8_t num_clients)</td></tr>
<tr class="memdesc:gac2570e24e41dc550252205489f56cc0f"><td class="mdescLeft">&#160;</td><td class="mdescRight">Gets the MAC address of the clients associated with the SoftAP.  <a href="group__group__wcm__functions.html#gac2570e24e41dc550252205489f56cc0f">More...</a><br /></td></tr>
<tr class="separator:gac2570e24e41dc550252205489f56cc0f"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:gadfcd3cdd92c62bcfd7b0ee53c7e4da7b"><td class="memItemLeft" align="right" valign="top">cy_rslt_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__group__wcm__functions.html#gadfcd3cdd92c62bcfd7b0ee53c7e4da7b">cy_wcm_set_ap_ip_setting</a> (<a class="el" href="structcy__wcm__ip__setting__t.html">cy_wcm_ip_setting_t</a> *ap_ip, const char *ip_addr, const char *netmask, const char *gateway_addr, <a class="el" href="group__group__wcm__enums.html#ga24d3def17207a3c64b62fb4b8a44a7fc">cy_wcm_ip_version_t</a> ver)</td></tr>
<tr class="memdesc:gadfcd3cdd92c62bcfd7b0ee53c7e4da7b"><td class="mdescLeft">&#160;</td><td class="mdescRight">Stores the AP settings provided by the user.  <a href="group__group__wcm__functions.html#gadfcd3cdd92c62bcfd7b0ee53c7e4da7b">More...</a><br /></td></tr>
<tr class="separator:gadfcd3cdd92c62bcfd7b0ee53c7e4da7b"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ga1d1d49639c74d84d8a609ee437a3c1c7"><td class="memItemLeft" align="right" valign="top">cy_rslt_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__group__wcm__functions.html#ga1d1d49639c74d84d8a609ee437a3c1c7">cy_wcm_allow_low_power_mode</a> (<a class="el" href="group__group__wcm__enums.html#ga1040bc30ffebcafe61bcb5ea677cd418">cy_wcm_powersave_mode_t</a> mode)</td></tr>
<tr class="memdesc:ga1d1d49639c74d84d8a609ee437a3c1c7"><td class="mdescLeft">&#160;</td><td class="mdescRight">Sets low power mode capability for WLAN CPU.  <a href="group__group__wcm__functions.html#ga1d1d49639c74d84d8a609ee437a3c1c7">More...</a><br /></td></tr>
<tr class="separator:ga1d1d49639c74d84d8a609ee437a3c1c7"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table>
<h2 class="groupheader">Function Documentation</h2>
<a id="ga888428a2325f131528f7447e894002eb" name="ga888428a2325f131528f7447e894002eb"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ga888428a2325f131528f7447e894002eb">&#9670;&nbsp;</a></span>cy_wcm_init()</h2>

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">cy_rslt_t cy_wcm_init </td>
          <td>(</td>
          <td class="paramtype"><a class="el" href="structcy__wcm__config__t.html">cy_wcm_config_t</a> *&#160;</td>
          <td class="paramname"><em>config</em></td><td>)</td>
          <td></td>
        </tr>
      </table>
</div><div class="memdoc">

<p>Initializes the WCM. </p>
<p >This function initializes the WCM resources, WHD, and Wi-Fi transport; turns Wi-Fi on; and starts up the network stack. This function should be called before calling other WCM APIs.</p>
<p >This function is supported in multi-core environment and it must be called in secondary core application before invoking any virtual WCM APIs. </p><dl class="section note"><dt>Note</dt><dd>The secondary core can invoke this API by passing the config parameter as NULL.</dd></dl>
<dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramdir">[in]</td><td class="paramname">config</td><td>The configuration to be initialized.</td></tr>
  </table>
  </dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>CY_RSLT_SUCCESS if WCM initialization was successful; returns <a class="el" href="group__cy__wcm__error.html">WCM-specific error codes</a> otherwise. </dd></dl>

</div>
</div>
<a id="ga5699a6a4d8f914d86022f3f973916316" name="ga5699a6a4d8f914d86022f3f973916316"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ga5699a6a4d8f914d86022f3f973916316">&#9670;&nbsp;</a></span>cy_wcm_deinit()</h2>

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">cy_rslt_t cy_wcm_deinit </td>
          <td>(</td>
          <td class="paramtype">void&#160;</td>
          <td class="paramname"></td><td>)</td>
          <td></td>
        </tr>
      </table>
</div><div class="memdoc">

<p>Shuts down the WCM. </p>
<p >This function cleans up all the resources of the WCM and brings down the Wi-Fi driver.</p>
<p >This function is supported in multi-core environment and can be invoked in the secondary core application which then cleans up all the resources of WCM in secondary core.</p>
<dl class="section note"><dt>Note</dt><dd>This API does not bring down the network stack because the default underlying stack does not have an implementation for deinit. Therefore, the expectation is that <a class="el" href="group__group__wcm__functions.html#ga888428a2325f131528f7447e894002eb">cy_wcm_init</a> and this API should be invoked only once.</dd></dl>
<dl class="section return"><dt>Returns</dt><dd>CY_RSLT_SUCCESS if the Wi-Fi module was successfully turned off; returns <a class="el" href="group__cy__wcm__error.html">WCM-specific error codes</a> otherwise. </dd></dl>

</div>
</div>
<a id="gae0f0b5f3e6138bfdae943e9f7b16aa07" name="gae0f0b5f3e6138bfdae943e9f7b16aa07"></a>
<h2 class="memtitle"><span class="permalink"><a href="#gae0f0b5f3e6138bfdae943e9f7b16aa07">&#9670;&nbsp;</a></span>cy_wcm_start_scan()</h2>

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">cy_rslt_t cy_wcm_start_scan </td>
          <td>(</td>
          <td class="paramtype"><a class="el" href="group__group__wcm__typedefs.html#ga58bd6c567dc6b0b111fb5852227c0c88">cy_wcm_scan_result_callback_t</a>&#160;</td>
          <td class="paramname"><em>scan_callback</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">void *&#160;</td>
          <td class="paramname"><em>user_data</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype"><a class="el" href="structcy__wcm__scan__filter__t.html">cy_wcm_scan_filter_t</a> *&#160;</td>
          <td class="paramname"><em>scan_filter</em>&#160;</td>
        </tr>
        <tr>
          <td></td>
          <td>)</td>
          <td></td><td></td>
        </tr>
      </table>
</div><div class="memdoc">

<p>Performs a Wi-Fi network scan. </p>
<p >The scan progressively accumulates results over time and may take between 1 and 10 seconds to complete. The results of the scan will be individually provided to the callback function. This API can be invoked while being connected to an AP.</p>
<dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramdir">[in]</td><td class="paramname">scan_callback</td><td>: Callback function which receives the scan results; callback will be executed in the context of the WCM. Scan results will be individually provided to this callback function. For more details on the scan results, see <a class="el" href="group__group__wcm__typedefs.html#ga58bd6c567dc6b0b111fb5852227c0c88">cy_wcm_scan_result_callback_t</a>. </td></tr>
    <tr><td class="paramdir">[in]</td><td class="paramname">user_data</td><td>: User data to be returned as an argument in the callback function when the callback function is invoked. </td></tr>
    <tr><td class="paramdir">[in]</td><td class="paramname">scan_filter</td><td>: Scan filter parameter passed for scanning (optional).</td></tr>
  </table>
  </dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>CY_RSLT_SUCCESS if the Wi-Fi network scan was successful; returns <a class="el" href="group__cy__wcm__error.html">WCM-specific error codes</a> otherwise. While a scan is in progress, if the user issues another scan, this API returns "CY_RSLT_WCM_SCAN_IN_PROGRESS". </dd></dl>

</div>
</div>
<a id="ga6c18f6560c581912393e297b1560d3c7" name="ga6c18f6560c581912393e297b1560d3c7"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ga6c18f6560c581912393e297b1560d3c7">&#9670;&nbsp;</a></span>cy_wcm_stop_scan()</h2>

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">cy_rslt_t cy_wcm_stop_scan </td>
          <td>(</td>
          <td class="paramtype">void&#160;</td>
          <td class="paramname"></td><td>)</td>
          <td></td>
        </tr>
      </table>
</div><div class="memdoc">

<p>Stops an ongoing Wi-Fi network scan. </p>
<dl class="section return"><dt>Returns</dt><dd>CY_RSLT_SUCCESS if the Wi-Fi network scan was successful; returns <a class="el" href="group__cy__wcm__error.html">WCM-specific error codes</a> otherwise. </dd></dl>

</div>
</div>
<a id="ga0aae35b5ae477a1a10caccf937beff0d" name="ga0aae35b5ae477a1a10caccf937beff0d"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ga0aae35b5ae477a1a10caccf937beff0d">&#9670;&nbsp;</a></span>cy_wcm_connect_ap()</h2>

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">cy_rslt_t cy_wcm_connect_ap </td>
          <td>(</td>
          <td class="paramtype"><a class="el" href="structcy__wcm__connect__params__t.html">cy_wcm_connect_params_t</a> *&#160;</td>
          <td class="paramname"><em>connect_params</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype"><a class="el" href="structcy__wcm__ip__address__t.html">cy_wcm_ip_address_t</a> *&#160;</td>
          <td class="paramname"><em>ip_addr</em>&#160;</td>
        </tr>
        <tr>
          <td></td>
          <td>)</td>
          <td></td><td></td>
        </tr>
      </table>
</div><div class="memdoc">

<p>Connects the STA interface to a AP using the Wi-Fi credentials and configuration parameters provided. </p>
<p >On a successful connection to the Wi-Fi network, the API returns the IP address. If the user does not know the security type of the AP then, connect_param.ap_credentials.security must be set to CY_WCM_SECURITY_UNKNOWN so that the library will internally find the security type before connecting to AP.</p>
<p >This API is a blocking call; this function additionally performs the following checks: 1) Checks for and ignores duplicate connect requests to an already connected AP. 2) Checks the current connection state; if already connected, disconnects from the current Wi-Fi network and connects to the new Wi-Fi network. 3) If the user does not know the security type of the AP, the library internally finds the security type.</p>
<dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramdir">[in]</td><td class="paramname">connect_params</td><td>: Configuration to join the AP. </td></tr>
    <tr><td class="paramdir">[out]</td><td class="paramname">ip_addr</td><td>: Pointer to return the IP address (optional).</td></tr>
  </table>
  </dd>
</dl>
<dl class="section note"><dt>Note</dt><dd>WEP (Wired Equivalent Privacy) security is not supported by this API. WEP-based authentication types are considered to be weaker security types; therefore, this function doesn't connect to an AP that is configured with WEP-based authentication.</dd></dl>
<dl class="section return"><dt>Returns</dt><dd>CY_RSLT_SUCCESS if connection is successful; returns <a class="el" href="group__cy__wcm__error.html">WCM-specific error codes</a> otherwise. </dd></dl>

</div>
</div>
<a id="gaabda4c932e13e0c8f29486d393a18c5b" name="gaabda4c932e13e0c8f29486d393a18c5b"></a>
<h2 class="memtitle"><span class="permalink"><a href="#gaabda4c932e13e0c8f29486d393a18c5b">&#9670;&nbsp;</a></span>cy_wcm_disconnect_ap()</h2>

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">cy_rslt_t cy_wcm_disconnect_ap </td>
          <td>(</td>
          <td class="paramtype">void&#160;</td>
          <td class="paramname"></td><td>)</td>
          <td></td>
        </tr>
      </table>
</div><div class="memdoc">

<p>Disconnects the STA interface from the currently connected AP. </p>
<dl class="section return"><dt>Returns</dt><dd>CY_RSLT_SUCCESS if disconnection was successful or if the device is already disconnected; returns <a class="el" href="group__cy__wcm__error.html">WCM-specific error codes</a> otherwise. </dd></dl>

</div>
</div>
<a id="gad15fb09ca84b85997b967c3a22f9676c" name="gad15fb09ca84b85997b967c3a22f9676c"></a>
<h2 class="memtitle"><span class="permalink"><a href="#gad15fb09ca84b85997b967c3a22f9676c">&#9670;&nbsp;</a></span>cy_wcm_get_ip_addr()</h2>

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">cy_rslt_t cy_wcm_get_ip_addr </td>
          <td>(</td>
          <td class="paramtype"><a class="el" href="group__group__wcm__enums.html#gac4c4ca6db8db6efdc3013b789a4c9cf8">cy_wcm_interface_t</a>&#160;</td>
          <td class="paramname"><em>interface_type</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype"><a class="el" href="structcy__wcm__ip__address__t.html">cy_wcm_ip_address_t</a> *&#160;</td>
          <td class="paramname"><em>ip_addr</em>&#160;</td>
        </tr>
        <tr>
          <td></td>
          <td>)</td>
          <td></td><td></td>
        </tr>
      </table>
</div><div class="memdoc">

<p>Retrieves the IPv4 address of the given interface. </p>
<p >See <a class="el" href="group__group__wcm__functions.html#ga88dbfc2742725a2c54223740cb27b518">cy_wcm_get_ipv6_addr</a> API to get IPv6 addresses.</p>
<dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramdir">[in]</td><td class="paramname">interface_type</td><td>: Type of the WCM interface. </td></tr>
    <tr><td class="paramdir">[out]</td><td class="paramname">ip_addr</td><td>: Pointer to an IP address structure (or) an IP address structure array. If the given interface is CY_WCM_INTERFACE_TYPE_STA or CY_WCM_INTERFACE_TYPE_AP upon return, index-0 stores the IPv4 address of the interface. If the given interface type is CY_WCM_INTERFACE_TYPE_AP_STA, index-0 stores the IPv4 address of the STA interface and index-1 stores the IPv4 address of the AP interface. ip_addr should have enough valid memory to hold two IP address structures.</td></tr>
  </table>
  </dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>CY_RSLT_SUCCESS if IP-address get is successful; returns <a class="el" href="group__cy__wcm__error.html">WCM-specific error codes</a> otherwise. </dd></dl>

</div>
</div>
<a id="ga88dbfc2742725a2c54223740cb27b518" name="ga88dbfc2742725a2c54223740cb27b518"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ga88dbfc2742725a2c54223740cb27b518">&#9670;&nbsp;</a></span>cy_wcm_get_ipv6_addr()</h2>

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">cy_rslt_t cy_wcm_get_ipv6_addr </td>
          <td>(</td>
          <td class="paramtype"><a class="el" href="group__group__wcm__enums.html#gac4c4ca6db8db6efdc3013b789a4c9cf8">cy_wcm_interface_t</a>&#160;</td>
          <td class="paramname"><em>interface_type</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype"><a class="el" href="group__group__wcm__enums.html#ga04051d082e24439e436a17db75fadfef">cy_wcm_ipv6_type_t</a>&#160;</td>
          <td class="paramname"><em>ipv6_addr_type</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype"><a class="el" href="structcy__wcm__ip__address__t.html">cy_wcm_ip_address_t</a> *&#160;</td>
          <td class="paramname"><em>ip_addr</em>&#160;</td>
        </tr>
        <tr>
          <td></td>
          <td>)</td>
          <td></td><td></td>
        </tr>
      </table>
</div><div class="memdoc">

<p>Retrieves the IPv6 address of the given interface. </p>
<p >Note: Currently, this API supports only <a class="el" href="group__group__wcm__enums.html#gga04051d082e24439e436a17db75fadfefa635adc564bdb3dbdd71685cef4f470ac">CY_WCM_IPV6_LINK_LOCAL</a> type.</p>
<dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramdir">[in]</td><td class="paramname">interface_type</td><td>: Type of the WCM interface. </td></tr>
    <tr><td class="paramdir">[in]</td><td class="paramname">ipv6_addr_type</td><td>: IPv6 address type. </td></tr>
    <tr><td class="paramdir">[out]</td><td class="paramname">ip_addr</td><td>: Pointer to an IP address structure (or) an IP address structure array. If the given interface is CY_WCM_INTERFACE_TYPE_STA or CY_WCM_INTERFACE_TYPE_AP upon return, index-0 stores the IPv6 link-local address of the interface. If the given interface type is CY_WCM_INTERFACE_TYPE_AP_STA, index-0 stores the IPv6 link-local address of the STA interface and index-1 stores the IPv6 link-local address of the AP interface. ip_addr should have enough valid memory to hold two IP address structures.</td></tr>
  </table>
  </dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>CY_RSLT_SUCCESS if IPv6 interface is up and IPv6 address is ready; returns <a class="el" href="group__cy__wcm__error.html">WCM-specific error codes</a> otherwise. </dd></dl>

</div>
</div>
<a id="ga4cb1814cad97c2462b27aec17294acfb" name="ga4cb1814cad97c2462b27aec17294acfb"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ga4cb1814cad97c2462b27aec17294acfb">&#9670;&nbsp;</a></span>cy_wcm_get_gateway_ip_address()</h2>

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">cy_rslt_t cy_wcm_get_gateway_ip_address </td>
          <td>(</td>
          <td class="paramtype"><a class="el" href="group__group__wcm__enums.html#gac4c4ca6db8db6efdc3013b789a4c9cf8">cy_wcm_interface_t</a>&#160;</td>
          <td class="paramname"><em>interface_type</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype"><a class="el" href="structcy__wcm__ip__address__t.html">cy_wcm_ip_address_t</a> *&#160;</td>
          <td class="paramname"><em>gateway_addr</em>&#160;</td>
        </tr>
        <tr>
          <td></td>
          <td>)</td>
          <td></td><td></td>
        </tr>
      </table>
</div><div class="memdoc">

<p>Retrieves the gateway IP address of the given interface. </p>
<dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramdir">[in]</td><td class="paramname">interface_type</td><td>: Type of the WCM interface. </td></tr>
    <tr><td class="paramdir">[out]</td><td class="paramname">gateway_addr</td><td>: Pointer to a single structure or an array of structures to be filled with the gateway IP address or addresses. If the given interface is CY_WCM_INTERFACE_TYPE_STA or CY_WCM_INTERFACE_TYPE_AP upon return, index-0 stores the IPv4 gateway address of the interface. If the given interface type is CY_WCM_INTERFACE_TYPE_AP_STA, index-0 stores the IPv4 gateway address of the STA interface and index-1 stores the IPV4 gateway address of the AP interface. gateway_addr should have enough valid memory to hold two IP address structures. In future, IPv6 addresses will be supported.</td></tr>
  </table>
  </dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>CY_RSLT_SUCCESS if retrieval of the gateway IP address was successful; returns <a class="el" href="group__cy__wcm__error.html">WCM-specific error codes</a> otherwise. </dd></dl>

</div>
</div>
<a id="ga0646e1f8eba6cda184c0251f504d6b69" name="ga0646e1f8eba6cda184c0251f504d6b69"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ga0646e1f8eba6cda184c0251f504d6b69">&#9670;&nbsp;</a></span>cy_wcm_get_ip_netmask()</h2>

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">cy_rslt_t cy_wcm_get_ip_netmask </td>
          <td>(</td>
          <td class="paramtype"><a class="el" href="group__group__wcm__enums.html#gac4c4ca6db8db6efdc3013b789a4c9cf8">cy_wcm_interface_t</a>&#160;</td>
          <td class="paramname"><em>interface_type</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype"><a class="el" href="structcy__wcm__ip__address__t.html">cy_wcm_ip_address_t</a> *&#160;</td>
          <td class="paramname"><em>net_mask_addr</em>&#160;</td>
        </tr>
        <tr>
          <td></td>
          <td>)</td>
          <td></td><td></td>
        </tr>
      </table>
</div><div class="memdoc">

<p>Retrieves the subnet mask address of the given interface. </p>
<dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramdir">[in]</td><td class="paramname">interface_type</td><td>: Type of the WCM interface. </td></tr>
    <tr><td class="paramdir">[out]</td><td class="paramname">net_mask_addr</td><td>: Pointer to a single structure or an array of structures to be filled with the subnet mask address or masks. If the given interface is CY_WCM_INTERFACE_TYPE_STA or CY_WCM_INTERFACE_TYPE_AP upon return, index-0 stores the subnet mask address of the interface. If the given interface type is CY_WCM_INTERFACE_TYPE_AP_STA, index-0 stores the subnet mask address of the STA interface and index-1 stores the subnet mask address of the AP interface. net_mask_addr should have enough valid memory to hold two IP address structures.</td></tr>
  </table>
  </dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>CY_RSLT_SUCCESS if retrieval of the subnet mask address was successful; returns <a class="el" href="group__cy__wcm__error.html">WCM-specific error codes</a> otherwise. </dd></dl>

</div>
</div>
<a id="ga0f9d3431e34472921e6b89d0a51d1538" name="ga0f9d3431e34472921e6b89d0a51d1538"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ga0f9d3431e34472921e6b89d0a51d1538">&#9670;&nbsp;</a></span>cy_wcm_get_mac_addr()</h2>

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">cy_rslt_t cy_wcm_get_mac_addr </td>
          <td>(</td>
          <td class="paramtype"><a class="el" href="group__group__wcm__enums.html#gac4c4ca6db8db6efdc3013b789a4c9cf8">cy_wcm_interface_t</a>&#160;</td>
          <td class="paramname"><em>interface_type</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype"><a class="el" href="group__group__wcm__typedefs.html#ga510db2323122294f3956024396ba2ff5">cy_wcm_mac_t</a> *&#160;</td>
          <td class="paramname"><em>mac_addr</em>&#160;</td>
        </tr>
        <tr>
          <td></td>
          <td>)</td>
          <td></td><td></td>
        </tr>
      </table>
</div><div class="memdoc">

<p>Retrieves the MAC address of the given interface. </p>
<dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramdir">[in]</td><td class="paramname">interface_type</td><td>: Type of the WCM interface. </td></tr>
    <tr><td class="paramdir">[out]</td><td class="paramname">mac_addr</td><td>: Pointer to a MAC address structure (or) a MAC address structure array. If the given interface is CY_WCM_INTERFACE_TYPE_STA or CY_WCM_INTERFACE_TYPE_AP upon return, index-0 stores the MAC address of the interface. If the given interface type is CY_WCM_INTERFACE_TYPE_AP_STA, index-0 stores the MAC address of the STA interface and index-1 stores the MAC address of the AP interface. mac_addr should have enough valid memory to hold two MAC address structures.</td></tr>
  </table>
  </dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>CY_RSLT_SUCCESS if the MAC address get is successful; returns <a class="el" href="group__cy__wcm__error.html">WCM-specific error codes</a> otherwise. </dd></dl>

</div>
</div>
<a id="ga97e7212b4d3392a310682ff02f0d8d51" name="ga97e7212b4d3392a310682ff02f0d8d51"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ga97e7212b4d3392a310682ff02f0d8d51">&#9670;&nbsp;</a></span>cy_wcm_wps_enrollee()</h2>

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">cy_rslt_t cy_wcm_wps_enrollee </td>
          <td>(</td>
          <td class="paramtype"><a class="el" href="structcy__wcm__wps__config__t.html">cy_wcm_wps_config_t</a> *&#160;</td>
          <td class="paramname"><em>config</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">const <a class="el" href="structcy__wcm__wps__device__detail__t.html">cy_wcm_wps_device_detail_t</a> *&#160;</td>
          <td class="paramname"><em>details</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype"><a class="el" href="structcy__wcm__wps__credential__t.html">cy_wcm_wps_credential_t</a> *&#160;</td>
          <td class="paramname"><em>credentials</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">uint16_t *&#160;</td>
          <td class="paramname"><em>credential_count</em>&#160;</td>
        </tr>
        <tr>
          <td></td>
          <td>)</td>
          <td></td><td></td>
        </tr>
      </table>
</div><div class="memdoc">

<p>Negotiates securely with a Wi-Fi Protected Setup (WPS) Registrar (usually an AP) and obtains the Wi-Fi network credentials. </p>
<dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramdir">[in]</td><td class="paramname">config</td><td>: Pointer to the WPS configuration information. </td></tr>
    <tr><td class="paramdir">[in]</td><td class="paramname">details</td><td>: Pointer to a structure containing manufacturing details of this device. </td></tr>
    <tr><td class="paramdir">[out]</td><td class="paramname">credentials</td><td>: Pointer to an array of credentials structure <a class="el" href="structcy__wcm__wps__credential__t.html">cy_wcm_wps_credential_t</a> to receive the AP credentials. </td></tr>
    <tr><td class="paramdir">[in,out]</td><td class="paramname">credential_count</td><td>: Upon invocation, this parameter stores the size of the credentials parameter. Upon return, denotes the actual number of credentials returned.</td></tr>
  </table>
  </dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>CY_RSLT_SUCCESS if credentials are retrieved successfully; returns <a class="el" href="group__cy__wcm__error.html">WCM-specific error codes</a> otherwise. </dd></dl>

</div>
</div>
<a id="ga0369189fc2845efdf57cd3ce9b0d188e" name="ga0369189fc2845efdf57cd3ce9b0d188e"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ga0369189fc2845efdf57cd3ce9b0d188e">&#9670;&nbsp;</a></span>cy_wcm_wps_generate_pin()</h2>

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">cy_rslt_t cy_wcm_wps_generate_pin </td>
          <td>(</td>
          <td class="paramtype">char&#160;</td>
          <td class="paramname"><em>wps_pin_string</em>[CY_WCM_WPS_PIN_LENGTH]</td><td>)</td>
          <td></td>
        </tr>
      </table>
</div><div class="memdoc">

<p>Generates a random WPS PIN for PIN mode connection. </p>
<dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramdir">[out]</td><td class="paramname">wps_pin_string</td><td>: Pointer to store the WPS PIN as a null-terminated string.</td></tr>
  </table>
  </dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>CY_RSLT_SUCCESS if WPS PIN generated; returns <a class="el" href="group__cy__wcm__error.html">WCM-specific error codes</a> otherwise. </dd></dl>

</div>
</div>
<a id="ga02f205b4d522c99d6c0b48f15683b0b6" name="ga02f205b4d522c99d6c0b48f15683b0b6"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ga02f205b4d522c99d6c0b48f15683b0b6">&#9670;&nbsp;</a></span>cy_wcm_register_event_callback()</h2>

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">cy_rslt_t cy_wcm_register_event_callback </td>
          <td>(</td>
          <td class="paramtype"><a class="el" href="group__group__wcm__typedefs.html#ga5f028848682f04705e669b6823d290fb">cy_wcm_event_callback_t</a>&#160;</td>
          <td class="paramname"><em>event_callback</em></td><td>)</td>
          <td></td>
        </tr>
      </table>
</div><div class="memdoc">

<p>Registers an event callback to monitor the connection and IP address change events. </p>
<p >This is an optional registration; use it if the application needs to monitor events across disconnection and reconnection of the STA interface and notifies the clients which are connected or disconnected from the SoftAP.</p>
<p >This API is supported in multi-core environment and can be invoked as a virtual API from the secondary core application.</p>
<p >Note: This API is expected to be called typically while being connected to an AP or once the SoftAP is up.</p>
<dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramdir">[in]</td><td class="paramname">event_callback</td><td>: Callback function to be invoked for event notification. The callback will be executed in the context of the WCM.</td></tr>
  </table>
  </dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>CY_RSLT_SUCCESS if application callback registration was successful; returns <a class="el" href="group__cy__wcm__error.html">WCM-specific error codes</a> otherwise. </dd></dl>

</div>
</div>
<a id="ga957a1964b1a2bf191266ee3e60549b9e" name="ga957a1964b1a2bf191266ee3e60549b9e"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ga957a1964b1a2bf191266ee3e60549b9e">&#9670;&nbsp;</a></span>cy_wcm_deregister_event_callback()</h2>

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">cy_rslt_t cy_wcm_deregister_event_callback </td>
          <td>(</td>
          <td class="paramtype"><a class="el" href="group__group__wcm__typedefs.html#ga5f028848682f04705e669b6823d290fb">cy_wcm_event_callback_t</a>&#160;</td>
          <td class="paramname"><em>event_callback</em></td><td>)</td>
          <td></td>
        </tr>
      </table>
</div><div class="memdoc">

<p>De-registers an event callback. </p>
<p >This API is supported in multi-core environment and can be invoked as a virtual API from the secondary core application.</p>
<dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramdir">[in]</td><td class="paramname">event_callback</td><td>: Callback function to de-register from getting notifications.</td></tr>
  </table>
  </dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>CY_RSLT_SUCCESS if application callback de-registration was successful; returns <a class="el" href="group__cy__wcm__error.html">WCM-specific error codes</a> otherwise. </dd></dl>

</div>
</div>
<a id="ga98c3513c75507fcddb7650b7d20b6f3a" name="ga98c3513c75507fcddb7650b7d20b6f3a"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ga98c3513c75507fcddb7650b7d20b6f3a">&#9670;&nbsp;</a></span>cy_wcm_is_connected_to_ap()</h2>

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">uint8_t cy_wcm_is_connected_to_ap </td>
          <td>(</td>
          <td class="paramtype">void&#160;</td>
          <td class="paramname"></td><td>)</td>
          <td></td>
        </tr>
      </table>
</div><div class="memdoc">

<p>Checks if the STA interface is connected to an AP. </p>
<p >This API is supported in multi-core environment and can be invoked as a virtual API from the secondary core application.</p>
<dl class="section return"><dt>Returns</dt><dd>1 if connected, 0 otherwise. </dd></dl>

</div>
</div>
<a id="gad91ebcdcf8452d23b68cf3b225b4ea33" name="gad91ebcdcf8452d23b68cf3b225b4ea33"></a>
<h2 class="memtitle"><span class="permalink"><a href="#gad91ebcdcf8452d23b68cf3b225b4ea33">&#9670;&nbsp;</a></span>cy_wcm_get_associated_ap_info()</h2>

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">cy_rslt_t cy_wcm_get_associated_ap_info </td>
          <td>(</td>
          <td class="paramtype"><a class="el" href="structcy__wcm__associated__ap__info__t.html">cy_wcm_associated_ap_info_t</a> *&#160;</td>
          <td class="paramname"><em>ap_info</em></td><td>)</td>
          <td></td>
        </tr>
      </table>
</div><div class="memdoc">

<p>Retrieves the information such as SSID, BSSID, and other details of the AP to which the STA interface is connected. </p>
<dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramdir">[out]</td><td class="paramname">ap_info</td><td>: Pointer to store the information of the associated AP <a class="el" href="structcy__wcm__associated__ap__info__t.html">cy_wcm_associated_ap_info_t</a>.</td></tr>
  </table>
  </dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>CY_RSLT_SUCCESS if retrieving the information of the associated AP was successful; returns <a class="el" href="group__cy__wcm__error.html">WCM-specific error codes</a> otherwise. </dd></dl>

</div>
</div>
<a id="ga6bf5f2a11f6b9a91d1be40cf79ab7e8c" name="ga6bf5f2a11f6b9a91d1be40cf79ab7e8c"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ga6bf5f2a11f6b9a91d1be40cf79ab7e8c">&#9670;&nbsp;</a></span>cy_wcm_get_wlan_statistics()</h2>

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">cy_rslt_t cy_wcm_get_wlan_statistics </td>
          <td>(</td>
          <td class="paramtype"><a class="el" href="group__group__wcm__enums.html#gac4c4ca6db8db6efdc3013b789a4c9cf8">cy_wcm_interface_t</a>&#160;</td>
          <td class="paramname"><em>interface</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype"><a class="el" href="structcy__wcm__wlan__statistics__t.html">cy_wcm_wlan_statistics_t</a> *&#160;</td>
          <td class="paramname"><em>stat</em>&#160;</td>
        </tr>
        <tr>
          <td></td>
          <td>)</td>
          <td></td><td></td>
        </tr>
      </table>
</div><div class="memdoc">

<p>Gets the WLAN statistics of the given interface from the time WLAN driver is up and running. </p>
<p >The application would typically use this API to get information such as "total transmitted packets" and "total received packets"; for more details, see members of <a class="el" href="structcy__wcm__wlan__statistics__t.html">cy_wcm_wlan_statistics_t</a>.</p>
<dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramdir">[in]</td><td class="paramname">interface</td><td>: Type of the WCM interface. </td></tr>
    <tr><td class="paramdir">[in]</td><td class="paramname">stat</td><td>: Pointer to store the statistics <a class="el" href="structcy__wcm__wlan__statistics__t.html">cy_wcm_wlan_statistics_t</a>.</td></tr>
  </table>
  </dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>CY_RSLT_SUCCESS if retrieval of statistics was successful; returns <a class="el" href="group__cy__wcm__error.html">WCM-specific error codes</a> otherwise. </dd></dl>

</div>
</div>
<a id="ga70f40907d2f1668b8fa356f8095fc172" name="ga70f40907d2f1668b8fa356f8095fc172"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ga70f40907d2f1668b8fa356f8095fc172">&#9670;&nbsp;</a></span>cy_wcm_get_gateway_mac_address()</h2>

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">cy_rslt_t cy_wcm_get_gateway_mac_address </td>
          <td>(</td>
          <td class="paramtype"><a class="el" href="group__group__wcm__typedefs.html#ga510db2323122294f3956024396ba2ff5">cy_wcm_mac_t</a> *&#160;</td>
          <td class="paramname"><em>mac_addr</em></td><td>)</td>
          <td></td>
        </tr>
      </table>
</div><div class="memdoc">

<p>Retrieves the MAC address of the gateway for STA interface. </p>
<p >Uses Address Resolution Protocol (ARP) to retrieve the gateway MAC address.</p>
<p >This function is a blocking call and uses an internal timeout while running ARP.</p>
<dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramdir">[out]</td><td class="paramname">mac_addr</td><td>: Pointer to a MAC address structure which is filled with the gateway's MAC address on successful return.</td></tr>
  </table>
  </dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>CY_RSLT_SUCCESS if retrieval of the gateway MAC address was successful; returns <a class="el" href="group__cy__wcm__error.html">WCM-specific error codes</a> otherwise. </dd></dl>

</div>
</div>
<a id="gaa42251a4b728f775786d1781afbc32a2" name="gaa42251a4b728f775786d1781afbc32a2"></a>
<h2 class="memtitle"><span class="permalink"><a href="#gaa42251a4b728f775786d1781afbc32a2">&#9670;&nbsp;</a></span>cy_wcm_ping()</h2>

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">cy_rslt_t cy_wcm_ping </td>
          <td>(</td>
          <td class="paramtype"><a class="el" href="group__group__wcm__enums.html#gac4c4ca6db8db6efdc3013b789a4c9cf8">cy_wcm_interface_t</a>&#160;</td>
          <td class="paramname"><em>interface</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype"><a class="el" href="structcy__wcm__ip__address__t.html">cy_wcm_ip_address_t</a> *&#160;</td>
          <td class="paramname"><em>ip_addr</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">uint32_t&#160;</td>
          <td class="paramname"><em>timeout_ms</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">uint32_t *&#160;</td>
          <td class="paramname"><em>elapsed_ms</em>&#160;</td>
        </tr>
        <tr>
          <td></td>
          <td>)</td>
          <td></td><td></td>
        </tr>
      </table>
</div><div class="memdoc">

<p>Sends a ping request to the given IP address. </p>
<p >This function is a blocking call; it returns after the specified timeout.</p>
<dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramdir">[in]</td><td class="paramname">interface</td><td>: Type of the WCM interface. </td></tr>
    <tr><td class="paramdir">[in]</td><td class="paramname">ip_addr</td><td>: Pointer to the destination IP address structure to which the ping request will be sent. </td></tr>
    <tr><td class="paramdir">[in]</td><td class="paramname">timeout_ms</td><td>: Ping request timeout in milliseconds. </td></tr>
    <tr><td class="paramdir">[out]</td><td class="paramname">elapsed_ms</td><td>: Pointer to store the round-trip time (in milliseconds), i.e., the time taken to receive the ping response from the destination.</td></tr>
  </table>
  </dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>CY_RSLT_SUCCESS if pinging to the IP address was successful; returns <a class="el" href="group__cy__wcm__error.html">WCM-specific error codes</a> otherwise. </dd></dl>

</div>
</div>
<a id="ga4b6c66ca0e28ef817bdab02c56d180e6" name="ga4b6c66ca0e28ef817bdab02c56d180e6"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ga4b6c66ca0e28ef817bdab02c56d180e6">&#9670;&nbsp;</a></span>cy_wcm_start_ap()</h2>

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">cy_rslt_t cy_wcm_start_ap </td>
          <td>(</td>
          <td class="paramtype">const <a class="el" href="structcy__wcm__ap__config__t.html">cy_wcm_ap_config_t</a> *&#160;</td>
          <td class="paramname"><em>ap_config</em></td><td>)</td>
          <td></td>
        </tr>
      </table>
</div><div class="memdoc">

<p>Starts an infrastructure Wi-Fi network (SoftAP). </p>
<p >This API is a blocking call; this function adds the information element to the SoftAP and starts an internal DHCP server.</p>
<dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramdir">[in]</td><td class="paramname">ap_config</td><td>: Configuration parameters for the SoftAP.</td></tr>
  </table>
  </dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>CY_RSLT_SUCCESS if SoftAp is started ; returns <a class="el" href="group__cy__wcm__error.html">WCM-specific error codes</a> otherwise. </dd></dl>

</div>
</div>
<a id="gaaf300adeaed2e9251dc85d6c85be9d72" name="gaaf300adeaed2e9251dc85d6c85be9d72"></a>
<h2 class="memtitle"><span class="permalink"><a href="#gaaf300adeaed2e9251dc85d6c85be9d72">&#9670;&nbsp;</a></span>cy_wcm_stop_ap()</h2>

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">cy_rslt_t cy_wcm_stop_ap </td>
          <td>(</td>
          <td class="paramtype">void&#160;</td>
          <td class="paramname"></td><td>)</td>
          <td></td>
        </tr>
      </table>
</div><div class="memdoc">

<p>Stops the infrastructure Wi-Fi network (SoftAP), removes the information element and stops the internal DHCP server. </p>
<dl class="section return"><dt>Returns</dt><dd>CY_RSLT_SUCCESS if connection is successful; returns <a class="el" href="group__cy__wcm__error.html">WCM-specific error codes</a> otherwise. </dd></dl>

</div>
</div>
<a id="gac2570e24e41dc550252205489f56cc0f" name="gac2570e24e41dc550252205489f56cc0f"></a>
<h2 class="memtitle"><span class="permalink"><a href="#gac2570e24e41dc550252205489f56cc0f">&#9670;&nbsp;</a></span>cy_wcm_get_associated_client_list()</h2>

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">cy_rslt_t cy_wcm_get_associated_client_list </td>
          <td>(</td>
          <td class="paramtype"><a class="el" href="group__group__wcm__typedefs.html#ga510db2323122294f3956024396ba2ff5">cy_wcm_mac_t</a> *&#160;</td>
          <td class="paramname"><em>sta_list</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">uint8_t&#160;</td>
          <td class="paramname"><em>num_clients</em>&#160;</td>
        </tr>
        <tr>
          <td></td>
          <td>)</td>
          <td></td><td></td>
        </tr>
      </table>
</div><div class="memdoc">

<p>Gets the MAC address of the clients associated with the SoftAP. </p>
<dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramdir">[out]</td><td class="paramname">sta_list</td><td>: Pointer to the MAC address (or) array of MAC addresses. The client's (STA) MAC address is stored on this array before the function returns.</td></tr>
    <tr><td class="paramdir">[in]</td><td class="paramname">num_clients</td><td>: Length of the array passed in sta_list.</td></tr>
  </table>
  </dd>
</dl>
<dl class="section note"><dt>Note</dt><dd>If the number of connected clients is less than the num_clients, then elements of sta_list beyond number of connected clients will be set to zero. The maximum number of supported client list varies for different Wi-Fi chips.</dd></dl>
<dl class="section return"><dt>Returns</dt><dd>CY_RSLT_SUCCESS If getting the client list is successful; returns <a class="el" href="group__cy__wcm__error.html">WCM-specific error codes</a> otherwise. </dd></dl>

</div>
</div>
<a id="gadfcd3cdd92c62bcfd7b0ee53c7e4da7b" name="gadfcd3cdd92c62bcfd7b0ee53c7e4da7b"></a>
<h2 class="memtitle"><span class="permalink"><a href="#gadfcd3cdd92c62bcfd7b0ee53c7e4da7b">&#9670;&nbsp;</a></span>cy_wcm_set_ap_ip_setting()</h2>

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">cy_rslt_t cy_wcm_set_ap_ip_setting </td>
          <td>(</td>
          <td class="paramtype"><a class="el" href="structcy__wcm__ip__setting__t.html">cy_wcm_ip_setting_t</a> *&#160;</td>
          <td class="paramname"><em>ap_ip</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">const char *&#160;</td>
          <td class="paramname"><em>ip_addr</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">const char *&#160;</td>
          <td class="paramname"><em>netmask</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">const char *&#160;</td>
          <td class="paramname"><em>gateway_addr</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype"><a class="el" href="group__group__wcm__enums.html#ga24d3def17207a3c64b62fb4b8a44a7fc">cy_wcm_ip_version_t</a>&#160;</td>
          <td class="paramname"><em>ver</em>&#160;</td>
        </tr>
        <tr>
          <td></td>
          <td>)</td>
          <td></td><td></td>
        </tr>
      </table>
</div><div class="memdoc">

<p>Stores the AP settings provided by the user. </p>
<p >NOTE: Dotted-decimal format example: 192.168.0.1</p>
<dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramdir">[in]</td><td class="paramname">ip_addr</td><td>: Pointer to an array containing the IP address of the AP in dotted-decimal format. </td></tr>
    <tr><td class="paramdir">[in]</td><td class="paramname">netmask</td><td>: Pointer to an array containing the network mask in dotted-decimal format. </td></tr>
    <tr><td class="paramdir">[in]</td><td class="paramname">gateway_addr</td><td>: Pointer to an array containing the gateway address in dotted-decimal format. </td></tr>
    <tr><td class="paramdir">[in]</td><td class="paramname">ver</td><td>: IP version. Possible values <a class="el" href="group__group__wcm__enums.html#gga24d3def17207a3c64b62fb4b8a44a7fcaa76a9ec3e0ee840982c8094f4416f768">CY_WCM_IP_VER_V6</a> or <a class="el" href="group__group__wcm__enums.html#gga24d3def17207a3c64b62fb4b8a44a7fca579126d4304962b6ee0f286e5afcbe8a">CY_WCM_IP_VER_V4</a>. </td></tr>
    <tr><td class="paramdir">[in]</td><td class="paramname">ap_ip</td><td>: Pointer to the variable which stores AP settings.</td></tr>
  </table>
  </dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>CY_RSLT_SUCCESS if the AP settings are successfully stored in the user-provided variable; returns <a class="el" href="group__cy__wcm__error.html">WCM-specific error codes</a> otherwise. </dd></dl>

</div>
</div>
<a id="ga1d1d49639c74d84d8a609ee437a3c1c7" name="ga1d1d49639c74d84d8a609ee437a3c1c7"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ga1d1d49639c74d84d8a609ee437a3c1c7">&#9670;&nbsp;</a></span>cy_wcm_allow_low_power_mode()</h2>

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">cy_rslt_t cy_wcm_allow_low_power_mode </td>
          <td>(</td>
          <td class="paramtype"><a class="el" href="group__group__wcm__enums.html#ga1040bc30ffebcafe61bcb5ea677cd418">cy_wcm_powersave_mode_t</a>&#160;</td>
          <td class="paramname"><em>mode</em></td><td>)</td>
          <td></td>
        </tr>
      </table>
</div><div class="memdoc">

<p>Sets low power mode capability for WLAN CPU. </p>
<dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramdir">[in]</td><td class="paramname">mode</td><td>- can be one of: CY_WCM_NO_POWERSAVE_MODE WLAN CPU will not go into powersave mode CY_WCM_PM1_POWERSAVE_MODE Powersave mode on specified interface without regard for throughput reduction CY_WCM_PM2_POWERSAVE_MODE Powersave mode on specified interface with High throughput</td></tr>
  </table>
  </dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>CY_RSLT_SUCCESS if the Wi-Fi module mode was successfully changed; returns <a class="el" href="group__cy__wcm__error.html">WCM-specific error codes</a> otherwise. </dd></dl>

</div>
</div>
</div><!-- contents -->
</div><!-- doc-content -->
<!-- start footer part -->
<div id="nav-path" class="navpath">
    <ul>
        <li class="footer">
            Generated for <b>Wi-Fi Connection Manager Library</b> by <b>Cypress Semiconductor Corporation</b>.
            All rights reserved.
        </li>
    </ul>
</div>
</body>
</html>
